<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.optim;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.Serializable;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math3.util.Pair;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * This class holds a point and the vectorial value of an objective function at<a name="line.23"></a>
<FONT color="green">024</FONT>     * that point.<a name="line.24"></a>
<FONT color="green">025</FONT>     *<a name="line.25"></a>
<FONT color="green">026</FONT>     * @see PointValuePair<a name="line.26"></a>
<FONT color="green">027</FONT>     * @see org.apache.commons.math3.analysis.MultivariateVectorFunction<a name="line.27"></a>
<FONT color="green">028</FONT>     * @version $Id: PointVectorValuePair.java 1416643 2012-12-03 19:37:14Z tn $<a name="line.28"></a>
<FONT color="green">029</FONT>     * @since 3.0<a name="line.29"></a>
<FONT color="green">030</FONT>     */<a name="line.30"></a>
<FONT color="green">031</FONT>    public class PointVectorValuePair extends Pair&lt;double[], double[]&gt; implements Serializable {<a name="line.31"></a>
<FONT color="green">032</FONT>        /** Serializable UID. */<a name="line.32"></a>
<FONT color="green">033</FONT>        private static final long serialVersionUID = 20120513L;<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>        /**<a name="line.35"></a>
<FONT color="green">036</FONT>         * Builds a point/objective function value pair.<a name="line.36"></a>
<FONT color="green">037</FONT>         *<a name="line.37"></a>
<FONT color="green">038</FONT>         * @param point Point coordinates. This instance will store<a name="line.38"></a>
<FONT color="green">039</FONT>         * a copy of the array, not the array passed as argument.<a name="line.39"></a>
<FONT color="green">040</FONT>         * @param value Value of the objective function at the point.<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        public PointVectorValuePair(final double[] point,<a name="line.42"></a>
<FONT color="green">043</FONT>                                    final double[] value) {<a name="line.43"></a>
<FONT color="green">044</FONT>            this(point, value, true);<a name="line.44"></a>
<FONT color="green">045</FONT>        }<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /**<a name="line.47"></a>
<FONT color="green">048</FONT>         * Build a point/objective function value pair.<a name="line.48"></a>
<FONT color="green">049</FONT>         *<a name="line.49"></a>
<FONT color="green">050</FONT>         * @param point Point coordinates.<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param value Value of the objective function at the point.<a name="line.51"></a>
<FONT color="green">052</FONT>         * @param copyArray if {@code true}, the input arrays will be copied,<a name="line.52"></a>
<FONT color="green">053</FONT>         * otherwise they will be referenced.<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        public PointVectorValuePair(final double[] point,<a name="line.55"></a>
<FONT color="green">056</FONT>                                    final double[] value,<a name="line.56"></a>
<FONT color="green">057</FONT>                                    final boolean copyArray) {<a name="line.57"></a>
<FONT color="green">058</FONT>            super(copyArray ?<a name="line.58"></a>
<FONT color="green">059</FONT>                  ((point == null) ? null :<a name="line.59"></a>
<FONT color="green">060</FONT>                   point.clone()) :<a name="line.60"></a>
<FONT color="green">061</FONT>                  point,<a name="line.61"></a>
<FONT color="green">062</FONT>                  copyArray ?<a name="line.62"></a>
<FONT color="green">063</FONT>                  ((value == null) ? null :<a name="line.63"></a>
<FONT color="green">064</FONT>                   value.clone()) :<a name="line.64"></a>
<FONT color="green">065</FONT>                  value);<a name="line.65"></a>
<FONT color="green">066</FONT>        }<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>        /**<a name="line.68"></a>
<FONT color="green">069</FONT>         * Gets the point.<a name="line.69"></a>
<FONT color="green">070</FONT>         *<a name="line.70"></a>
<FONT color="green">071</FONT>         * @return a copy of the stored point.<a name="line.71"></a>
<FONT color="green">072</FONT>         */<a name="line.72"></a>
<FONT color="green">073</FONT>        public double[] getPoint() {<a name="line.73"></a>
<FONT color="green">074</FONT>            final double[] p = getKey();<a name="line.74"></a>
<FONT color="green">075</FONT>            return p == null ? null : p.clone();<a name="line.75"></a>
<FONT color="green">076</FONT>        }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>        /**<a name="line.78"></a>
<FONT color="green">079</FONT>         * Gets a reference to the point.<a name="line.79"></a>
<FONT color="green">080</FONT>         *<a name="line.80"></a>
<FONT color="green">081</FONT>         * @return a reference to the internal array storing the point.<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        public double[] getPointRef() {<a name="line.83"></a>
<FONT color="green">084</FONT>            return getKey();<a name="line.84"></a>
<FONT color="green">085</FONT>        }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>        /**<a name="line.87"></a>
<FONT color="green">088</FONT>         * Gets the value of the objective function.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @return a copy of the stored value of the objective function.<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        @Override<a name="line.92"></a>
<FONT color="green">093</FONT>        public double[] getValue() {<a name="line.93"></a>
<FONT color="green">094</FONT>            final double[] v = super.getValue();<a name="line.94"></a>
<FONT color="green">095</FONT>            return v == null ? null : v.clone();<a name="line.95"></a>
<FONT color="green">096</FONT>        }<a name="line.96"></a>
<FONT color="green">097</FONT>    <a name="line.97"></a>
<FONT color="green">098</FONT>        /**<a name="line.98"></a>
<FONT color="green">099</FONT>         * Gets a reference to the value of the objective function.<a name="line.99"></a>
<FONT color="green">100</FONT>         *<a name="line.100"></a>
<FONT color="green">101</FONT>         * @return a reference to the internal array storing the value of<a name="line.101"></a>
<FONT color="green">102</FONT>         * the objective function.<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        public double[] getValueRef() {<a name="line.104"></a>
<FONT color="green">105</FONT>            return super.getValue();<a name="line.105"></a>
<FONT color="green">106</FONT>        }<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>        /**<a name="line.108"></a>
<FONT color="green">109</FONT>         * Replace the instance with a data transfer object for serialization.<a name="line.109"></a>
<FONT color="green">110</FONT>         * @return data transfer object that will be serialized<a name="line.110"></a>
<FONT color="green">111</FONT>         */<a name="line.111"></a>
<FONT color="green">112</FONT>        private Object writeReplace() {<a name="line.112"></a>
<FONT color="green">113</FONT>            return new DataTransferObject(getKey(), getValue());<a name="line.113"></a>
<FONT color="green">114</FONT>        }<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>        /** Internal class used only for serialization. */<a name="line.116"></a>
<FONT color="green">117</FONT>        private static class DataTransferObject implements Serializable {<a name="line.117"></a>
<FONT color="green">118</FONT>            /** Serializable UID. */<a name="line.118"></a>
<FONT color="green">119</FONT>            private static final long serialVersionUID = 20120513L;<a name="line.119"></a>
<FONT color="green">120</FONT>            /**<a name="line.120"></a>
<FONT color="green">121</FONT>             * Point coordinates.<a name="line.121"></a>
<FONT color="green">122</FONT>             * @Serial<a name="line.122"></a>
<FONT color="green">123</FONT>             */<a name="line.123"></a>
<FONT color="green">124</FONT>            private final double[] point;<a name="line.124"></a>
<FONT color="green">125</FONT>            /**<a name="line.125"></a>
<FONT color="green">126</FONT>             * Value of the objective function at the point.<a name="line.126"></a>
<FONT color="green">127</FONT>             * @Serial<a name="line.127"></a>
<FONT color="green">128</FONT>             */<a name="line.128"></a>
<FONT color="green">129</FONT>            private final double[] value;<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>            /** Simple constructor.<a name="line.131"></a>
<FONT color="green">132</FONT>             * @param point Point coordinates.<a name="line.132"></a>
<FONT color="green">133</FONT>             * @param value Value of the objective function at the point.<a name="line.133"></a>
<FONT color="green">134</FONT>             */<a name="line.134"></a>
<FONT color="green">135</FONT>            public DataTransferObject(final double[] point, final double[] value) {<a name="line.135"></a>
<FONT color="green">136</FONT>                this.point = point.clone();<a name="line.136"></a>
<FONT color="green">137</FONT>                this.value = value.clone();<a name="line.137"></a>
<FONT color="green">138</FONT>            }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>            /** Replace the deserialized data transfer object with a {@link PointValuePair}.<a name="line.140"></a>
<FONT color="green">141</FONT>             * @return replacement {@link PointValuePair}<a name="line.141"></a>
<FONT color="green">142</FONT>             */<a name="line.142"></a>
<FONT color="green">143</FONT>            private Object readResolve() {<a name="line.143"></a>
<FONT color="green">144</FONT>                return new PointVectorValuePair(point, value, false);<a name="line.144"></a>
<FONT color="green">145</FONT>            }<a name="line.145"></a>
<FONT color="green">146</FONT>        }<a name="line.146"></a>
<FONT color="green">147</FONT>    }<a name="line.147"></a>




























































</PRE>
</BODY>
</HTML>
